juce/source/extras/the jucer/src/model/components/jucer_HyperlinkButtonHandler.h

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library - "Jules' Utility Class Extensions"
   5    Copyright 2004-11 by Raw Material Software Ltd.
   6
   7   ------------------------------------------------------------------------------
   8
   9    JUCE can be redistributed and/or modified under the terms of the GNU General
  10    Public License (Version 2), as published by the Free Software Foundation.
  11    A copy of the license is included in the JUCE distribution, or can be found
  12    online at www.gnu.org/licenses.
  13
  14    JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
  15    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  16    A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  17
  18   ------------------------------------------------------------------------------
  19
  20    To release a closed-source product which uses JUCE, commercial licenses are
  21    available: visit www.rawmaterialsoftware.com/juce for more information.
  22
  23   ==============================================================================
  24 */
  25
  26 #ifndef __JUCER_HYPERLINKBUTTONHANDLER_JUCEHEADER__
  27 #define __JUCER_HYPERLINKBUTTONHANDLER_JUCEHEADER__
  28
  29 #include "jucer_ButtonHandler.h"
  30
  31
  32 //==============================================================================
  33 /**
  34 */
  35 class HyperlinkButtonHandler  : public ButtonHandler
  36 {
  37 public:
  38     //==============================================================================
  39     HyperlinkButtonHandler()
  40         : ButtonHandler ("Hyperlink Button", "HyperlinkButton", typeid (HyperlinkButton), 150, 24)
  41     {
  42         registerColour (HyperlinkButton::textColourId, "text", "textCol");
  43     }
  44
  45     //==============================================================================
  46     Component* createNewComponent (JucerDocument*)
  47     {
  48         HyperlinkButton* hb = new HyperlinkButton ("new hyperlink", URL ("http://www.rawmaterialsoftware.com/juce"));
  49
  50         setNeedsButtonListener (hb, false);
  51         return hb;
  52     }
  53
  54     void getEditableProperties (Component* component, JucerDocument& document, Array <PropertyComponent*>& properties)
  55     {
  56         HyperlinkButton* const hb = (HyperlinkButton*) component;
  57
  58         ButtonHandler::getEditableProperties (component, document, properties);
  59
  60         properties.add (new HyperlinkURLProperty (hb, document));
  61
  62         addColourProperties (component, document, properties);
  63     }
  64
  65     XmlElement* createXmlFor (Component* comp, const ComponentLayout* layout)
  66     {
  67         HyperlinkButton* const hb = (HyperlinkButton*) comp;
  68
  69         XmlElement* const e = ButtonHandler::createXmlFor (comp, layout);
  70
  71         e->setAttribute ("url", hb->getURL().toString (false));
  72
  73         return e;
  74     }
  75
  76     bool restoreFromXml (const XmlElement& xml, Component* comp, const ComponentLayout* layout)
  77     {
  78         HyperlinkButton* const hb = (HyperlinkButton*) comp;
  79
  80         if (! ButtonHandler::restoreFromXml (xml, comp, layout))
  81             return false;
  82
  83         hb->setURL (URL (xml.getStringAttribute ("url", hb->getURL().toString (false))));
  84
  85         return true;
  86     }
  87
  88     const String getCreationParameters (Component* comp)
  89     {
  90         HyperlinkButton* const hb = dynamic_cast <HyperlinkButton*> (comp);
  91
  92         return quotedString (hb->getButtonText())
  93                 + ",\nURL ("
  94                 + quotedString (hb->getURL().toString (false))
  95                 + ")";
  96     }
  97
  98     void fillInCreationCode (GeneratedCode& code, Component* component, const String& memberVariableName)
  99     {
 100         ButtonHandler::fillInCreationCode (code, component, memberVariableName);
 101
 102         code.constructorCode << getColourIntialisationCode (component, memberVariableName)
 103                              << '\n';
 104     }
 105
 106 private:
 107     //==============================================================================
 108     class HyperlinkURLProperty  : public ComponentTextProperty <HyperlinkButton>
 109     {
 110     public:
 111         HyperlinkURLProperty (HyperlinkButton* component_, JucerDocument& document_)
 112             : ComponentTextProperty <HyperlinkButton> ("URL", 512, false, component_, document_)
 113         {}
 114
 115         //==============================================================================
 116         void setText (const String& newText)
 117         {
 118             document.perform (new HyperlinkURLChangeAction (component, *document.getComponentLayout(), URL (newText)),
 119                               "Change hyperlink URL");
 120         }
 121
 122         const String getText() const
 123         {
 124             return component->getURL().toString (false);
 125         }
 126
 127     private:
 128         class HyperlinkURLChangeAction  : public ComponentUndoableAction <HyperlinkButton>
 129         {
 130         public:
 131             HyperlinkURLChangeAction (HyperlinkButton* const comp, ComponentLayout& layout, const URL& newState_)
 132                 : ComponentUndoableAction <HyperlinkButton> (comp, layout),
 133                   newState (newState_)
 134             {
 135                 oldState = comp->getURL();
 136             }
 137
 138             bool perform()
 139             {
 140                 showCorrectTab();
 141                 getComponent()->setURL (newState);
 142                 changed();
 143                 return true;
 144             }
 145
 146             bool undo()
 147             {
 148                 showCorrectTab();
 149                 getComponent()->setURL (oldState);
 150                 changed();
 151                 return true;
 152             }
 153
 154             URL newState, oldState;
 155         };
 156     };
 157
 158 };
 159
 160
 161 #endif   // __JUCER_HYPERLINKBUTTONHANDLER_JUCEHEADER__